home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 27 / CU Amiga Magazine's Super CD-ROM 27 (1998)(EMAP Images)(GB)[!][issue 1998-10].iso / CUCD / Sound / SPlayer / Socks5 / README < prev    next >
Text File  |  1997-06-03  |  11KB  |  277 lines
  1. Welcome to NWSL's (previously CSTC) socksv5!
  2.  
  3. socksv5 allows UNIX hosts behind a firewall to gain full access to the
  4. Internet without requiring direct IP reachability. socksv5 requires a SOCKS
  5. daemon running on a host that can communicate directly with hosts behind the
  6. firewall and with hosts on the Internet. socksv5 is based on the original
  7. SOCKS, written by David Koblas <koblas@netcom.com>, and the IETF AFT working
  8. group.
  9.  
  10. NEC developed the socks5 system using GNU's ANSI-C compiler. You must use an
  11. ANSI-C compiler to build your socks5 system. If you experience problems
  12. building socks5 with your native compiler, we recommend using GNU's ANSI-C
  13. compiler. You can download GNU's ANCI-C compiler, tar, and zip from:
  14.             ftp://prep.ai.mit.edu/pub/gnu/
  15.  
  16. To support some socks5 protocol features, requires available libraries and
  17. programs on your system. Some of these requirements include:
  18.     - To build socks5 with GSS-API authentication requires a Kerberos5-based
  19.       GSS-API library.
  20.     - To build socks5 with IDENT, you need an ident library.
  21.     - To build socks5 with monitoring, you need the SOCKS5WatchAG library.
  22.     - To support the ping and traceroute proxies, you must have these
  23.       programs in your PATH.
  24.  
  25.  
  26. socks5 Daemon
  27. =============
  28.  
  29. The socks5 daemon can run:
  30.     - standalone
  31.     - pre-forking, by adding the -p flag
  32.     - threaded, by adding the -t flag if you configured with the
  33.       --with-threads options and the operating system supports
  34.       POSIX threads
  35.     - through inetd, by adding the -i flag
  36.  
  37. socks runs in threaded mode if the operating system supports POSIX threads.
  38. Because the optimum mode is highly operating system and hardware dependent,
  39. it is impossible to state the best mode.
  40.  
  41. NEC has tested threading on Solaris and IRIX UNIX systems. Be aware that all
  42. operating systems impose limits on the number of threads and the number of
  43. open file descriptors per process.
  44.  
  45. The maximum number of child processes limits standalone and pre-forking
  46. modes. The default number of child processes is 64. The socks5 daemon
  47. includes a -n(--nchildren) option to change the default. The number of socks5
  48. child processes can not exceed the system limit.
  49.  
  50. To turn on debug mode, include the -d flag or configure with the
  51. --with-debug option. Only use debug mode when you must debug the server.
  52. During debugging, you may want to include the -o flag to force the server
  53. to accept only one request and to prevent it from forking.
  54.  
  55. Use the -f flag to keep standalone versions in the foreground. 
  56.  
  57. Kerberos users: You may experience problems building the shared library if
  58. your Kerberos libraries are not sharable. After successfully including the
  59. Kerberos libraries, extraneous characters may appear in your output. The
  60. extra characters are a result of how your shared linker replaces read and
  61. write calls. Try using runsocks without integrity or confidentiality
  62. checking. To omit integrity and confidentiality, set SOCKS5_NOINTCHK in
  63. your environment before using runsocks.
  64.  
  65. RealAudio requires no special setup.
  66.  
  67.  
  68. Configuration Parameters
  69. ========================
  70.  
  71. Please read INSTALL for configure and compile instructions. socks5 includes
  72. several package-specific options that you can include with the ./configure
  73. command. Some of the most commonly used options include: 
  74.  
  75. --with-krb5[=path]
  76. Sets socks5 to build with Kerberos support and optionally sets the location
  77. of the Kerberos library. If you omit the path, socks5 checks for krlogin
  78. lines in /etc/inetd.conf 
  79.  
  80. --with-ident[=path]
  81. Sets socks5 to support ident mode and optionally sets the location of the
  82. ident header file and library.
  83.  
  84. --with-debug
  85. Turns on debug and compile time warnings, for gcc, and turns off
  86. optimization
  87.  
  88. --with-static
  89. Turns on static compilation of most binaries
  90.  
  91. --with-threads
  92. Turns on thread support if the operating system supports it
  93.  
  94. --with-libconffile=filename
  95. Sets the client configuration file. If you omit this option, socks5 uses
  96. /etc/libsocks5.conf in most cases. Under FreeBSD's UNIX port, the configuration
  97. file resides in /usr/local/etc/libsocks5.conf.
  98.  
  99. --with-srvconffile=filename
  100. Sets the server configuration file. If you omit this option, socks5 uses
  101. /etc/socks5.conf in most cases. Under FreeBSD's UNIX port, the configuration 
  102. file resides in /usr/local/etc/socks5.conf.
  103.  
  104. --with-srvpidfile=filename
  105. Sets the server pid file, where the socks5 daemon stores its process id. If
  106. you omit this option, the daemon stores its pid in /tmp/socks5.pid.
  107.  
  108. --with-srvpwdfile=filename
  109. Sets the server Username/Password authentication file. If you omit this
  110. option, socks5 uses /etc/socks5.passwd in most cases. Under FreeBSD's UNIX 
  111. port, the password file resides in /usr/local/etc/socks5.passwd.
  112.  
  113. --with-srvidtfile=filename
  114. Sets the server ident file. If you omit this option, socks5 stores the ident 
  115. file in /tmp/socks5.ident.
  116.  
  117. --with-default-port=number
  118. Sets the default socks port number. socks5 uses port 1080 if you omit this
  119. option.
  120.  
  121. --with-default-server=hostname
  122. Sets the default socks server. If you omit this option, socks uses the local
  123. host.
  124.  
  125. --with-default-version=number
  126. Sets the default socks version. If you omit this option, socks uses direct
  127. connect.
  128.  
  129. --with-syslog-facility=facility
  130. Sets the default syslog facility. socks5 uses LOG_DAEMON when you omit this
  131. option.
  132.  
  133. --with-monitor[=path]
  134. Specifies to build NEC's SOCKS5WatchAG support and optionally specifies the
  135. location for SOCKS5WatchAG's include files and library.
  136.  
  137. --with-passwd
  138. Instructs socks5 to use the system password file in socks5 Username/Password
  139. exchanges instead of the socks5 username and password file. For security
  140. reasons, we do NOT recommend this option.
  141.  
  142. socks5 Configuration Files
  143. ==========================
  144.  
  145. The socks5 daemon requires a configuration file, socks5.conf. socks5 clients
  146. optionally read the client configuration file, libsocks.conf. If you omit
  147. the libsocks5.conf file, set the SOCKS5_SERVER environment variable.
  148.  
  149. socks5.conf supports these entries:
  150.  
  151.     auth lines        - identify the types of authentication the socks5
  152.                             daemon can use. The server requires auth lines 
  153.                             to perform authentication.
  154.  
  155.     route lines       - identify to the server which network interfaces
  156.                             the server should use for outbound connections.
  157.                             We strongly recommend using route entries in a
  158.                             multi-homed server configuration file. It is
  159.                             more efficient to use a default route entry with
  160.                             the destination address and port fields set to
  161.                             any, "-". route lines are not useful for 
  162.                             single-homed servers.
  163.  
  164.     proxy lines       - identify to the server how it should establish a
  165.                             proxy connection, directly or through another 
  166.                             socks server. You MUST include proxy entries to
  167.                             make server-to-server (VPN) connections.
  168.  
  169.     permit/deny lines - identify to the server the connection requests 
  170.                             that it should authorize. The order of
  171.                             permit/deny lines is critical because the server
  172.                             checks permit/deny entries in sequential order.
  173.                             When it locates a match, it stops checking. When
  174.                             the server fails to locate a match, it denies
  175.                             authorization. You MUST have at least one permit
  176.                             entry in your socks5.conf file.
  177.  
  178. The socks5 daemon supports both socks4 and socks5 clients and communicates
  179. with SOCKS4 servers. Be aware of the differences between socks5 and SOCKS4
  180. servers.
  181.  
  182.  
  183. socks5 Clients
  184. ==============
  185.  
  186. The socks5 package includes client applications intended to demonstrate the
  187. socksification process. Developers using the socks5 package submitted the 
  188. applications to NEC. NEC did NOT write the applications. Although they work,
  189. they do contain bugs. NEC has no intention of fixing or maintaining these
  190. applications. We will try to include newer versions of these applications in
  191. future releases. This distribution includes these socks5 clients: ftp,
  192. telnet, archie, finger, whois, rping, and rtraceroute.
  193.  
  194. If your operating systems supports shared libraries, the socks5 package
  195. builds the socks shared library. The shared library allows non-socks5 clients
  196. to run with the runsocks shell script included in the shlib directory.
  197.  
  198. runsocks re-orders the dynamic library, linking the new shared library
  199. before libc, resulting in some socksified commands, including connect and
  200. bind. runsocks works under FreeBSD 2, SunOS 4, Solaris 2, Irix 5, and OSF1.
  201. runsocks dynamically socksifies existing applications, without recompiling.
  202. To use runsocks:
  203.  
  204.     - Your operating system must support the socks5 shared library
  205.     - Your operating system must support the dynamic shared library 
  206.       loading path
  207.     - You must build applications with the dynamic shared C and
  208.       socket libraries
  209.  
  210. NEC tested the current version of runsocks on Solaris, SunOS, OSF1, IRIX,
  211. and Linux.
  212.  
  213.  
  214. Platforms
  215. =========
  216.  
  217. socks5 relies on the operating system. We try to support as many operating
  218. systems as possible. However, it is impossible to support all UNIX
  219. platforms. We release the source and encourage others to support additional
  220. UNIX platforms.
  221.  
  222. Operating systems do contain bugs. We cannot fix those bugs and encourage
  223. you to submit these problems to your operating system developers for bug
  224. fixes. For example, Linux 2.0 has bugs in the shared library loader that
  225. cause a segmentation fault message following runsocks.
  226.  
  227.  
  228. socks5 Error Messages
  229. =====================
  230.  
  231. Developers are the intended audience for most logging messages. We recommend
  232. that you refer to the source code to fully understand the messages. Error
  233. messages in the log file do not mean the server malfunctioned. For example,
  234. some HTTP proxies generate S5IORecv ...  messages.
  235.  
  236.  
  237. Mailing Lists
  238. =============
  239.  
  240. NEC maintains a mailing list, socks5@syl.dl.nec.com, to discuss problems
  241. and suggestions. To subscribe, send mail to:
  242.  
  243.     majordomo@socks.nec.com
  244.  
  245. In your mail message, omit the Subject. Include a one-line body containing:
  246.  
  247.     subscribe socks5
  248.  
  249.  
  250. socks5 Bugs
  251. ===========
  252.  
  253. We encourage all socks5 users to report problems and provide patches for
  254. problems you encounter with socks5. 
  255.  
  256. PLEASE NOTE: When submitting bug reports, it is most helpful for you to
  257. include debug output. Debug output greatly assists us in isolating problems.
  258. To turn on debug mode for clients, set the client environment variable
  259. SOCKS5_DEBUG. To turn on debug mode when you start the socks5 daemon,
  260. include the -d flag.
  261.  
  262. To submit problem reports, or send mail not distributed to a mailing list,
  263. send mail to:
  264.         socks5-bugs@syl.dl.nec.com
  265.  
  266.  
  267. socks5 Information
  268. ==================
  269.  
  270. We welcome your comments to: socks5-comments@socks.nec.com
  271.  
  272. For more information on how to build and use the socks5, please visit our 
  273. socks web site at:
  274.     http://www.socks.nec.com/
  275.  
  276.  
  277.